irtrans/shlib/src/IRTrans Shared Lib Doc.txt

   1 Documentation for the IRTrans Shared Library
   2
   3
   4 The IRTrans Shared Library allows to control IRTrans devices through own programms.
   5
   6 The Shared Lib is available for Windows (IRTransDLL.dll) and LINUX (libIRTrans.so).
   7
   8
   9
  10 Needed Header Files
  11
  12 IRTrans.h
  13 remote.h
  14 network.h
  15 errcode.h
  16
  17
  18 Theory of operation
  19
  20 The IRTrans system is always controlled using a TCP/IP based server software (irserver).
  21 The Shared LIB connects to this server via port TCP/21000 and allows to control the
  22 IRTrans system. In addition some of the functions are also available directly when
  23 connected to an IRTrans LAN device with integrated IRDB.
  24 Once connected the client programm can operate the IRTrans device(s).
  25
  26
  27 Calls
  28
  29 **************************************************************
  30
  31 General / Control
  32
  33 **************************************************************
  34
  35
  36 int ConnectIRTransServer (char host[],SOCKET *sock)
  37
  38 Connect to an IRTrans server. This is the first step needed
  39 to establish communication with the IRTrans system.
  40 The IP / hostname can also refer to an IRTrans Ethernet module.
  41 Of course multiple connections are supported.
  42
  43 Supported
  44
  45 irserver                >= 5.1.1
  46 LAN DB modules  all versions
  47
  48
  49 Parameters
  50
  51 char host[]
  52
  53 Hostname or IP Address where the server is running.
  54 This can be localhost for a server running on the same system or
  55 the IP / hostname of a remote server.
  56
  57
  58 SOCKET *sock
  59
  60 Pointer to a SOCKET where the handle for the connection is stored.
  61
  62
  63 Result
  64
  65 0               Call succeeded
  66 != 0    Error Code returend (Definitions in errcode.h)
  67
  68
  69 --------------------------------------------------------------
  70
  71
  72 void DisconnectIRTransServer (SOCKET serv)
  73
  74 Closes the connection with the irserver
  75
  76 Supported
  77
  78 irserver                all versions
  79 LAN DB modules  all versions
  80
  81
  82 Parameters
  83
  84 SOCKET serv
  85
  86 Connection handle for the irserver connection
  87
  88
  89 --------------------------------------------------------------
  90
  91
  92 NETWORKSTATUS *ReloadIRDatabase (SOCKET serv)
  93
  94 Reloads the IR Database files. Only needed when the files
  95 are changed manually. When learning codes through the server
  96 the correct status is always maintained by the irserver.
  97
  98 Supported
  99
 100 irserver                >= 5.1.1
 101 LAN DB modules  not supported / needed
 102
 103
 104 Parameters
 105
 106 SOCKET serv
 107
 108 Connection handle for the irserver connection
 109
 110
 111 Result
 112
 113 0               Call succeeded / no Error
 114 != 0    NETWORKSTATUS structure describing the Error
 115
 116
 117
 118
 119 **************************************************************
 120
 121 Sending IR
 122
 123 **************************************************************
 124
 125
 126 NETWORKSTATUS *SendRemoteCommand (SOCKET serv, char rem[],char com[],int mask,int LEDSel,int bus)
 127
 128 Send an IR Code
 129
 130 Supported
 131
 132 irserver                >= 5.1.1
 133 LAN DB modules  all versions
 134
 135
 136 Parameters
 137
 138 SOCKET serv
 139
 140 Connection handle for the irserver connection
 141
 142 char rem[]
 143
 144 Name of the remote control
 145
 146 char com[]
 147
 148 Name of the IR Command
 149
 150 int mask
 151
 152 Address mask for the IRTrans serial Bus. Contains a 16 Bit bit mask for up to 16 devices.
 153 0xffff -> Send to all devices on the Bus
 154
 155 int LEDSel
 156
 157 Select the LEDs used to send.
 158
 159 Values:
 160 0       Default (as set in devices EEPROM)
 161 1       Internal LEDs
 162 2       External LEDs
 163 3       All LEDs
 164
 165 int bus
 166
 167 Select the LAN / USB / RS232 device connected to the server. 0 = first device, 1 = 2nd and so on.
 168 255 selects all busses / devices.
 169
 170 Result
 171
 172 0               Call succeeded / no Error
 173 != 0    NETWORKSTATUS structure describing the Error
 174
 175
 176 --------------------------------------------------------------
 177
 178
 179 NETWORKSTATUS *SendRemoteCommandEx (SOCKET serv,char rem[],char com[],word mask,byte LEDSel,byte bus)
 180
 181 Send an IR Code. Extended external LED selection.
 182
 183
 184 Supported
 185
 186 irserver                >= 5.1.1
 187 LAN DB modules  all versions
 188
 189
 190 Parameters
 191
 192 SOCKET serv
 193
 194 Connection handle for the irserver connection
 195
 196 char rem[]
 197
 198 Name of the remote control
 199
 200 char com[]
 201
 202 Name of the IR Command
 203
 204 int mask
 205
 206 Address mask for the IRTrans serial Bus. Contains a 16 Bit bit mask for up to 16 devices.
 207 0xffff -> Send to all devices on the Bus
 208
 209 byte LEDSel
 210
 211 Select the LEDs used to send.
 212
 213 Values:
 214
 215 0 or d          Default (as set in devices EEPROM)
 216 i                       Internal LEDs
 217 e                       External LEDs
 218 b or a          All LEDs
 219 1 to 8          External LEDs of LAN Controller / LAN Controller XL
 220
 221 int bus
 222
 223 Select the LAN / USB / RS232 device connected to the server. 0 = first device, 1 = 2nd and so on.
 224 255 selects all busses / devices.
 225
 226 Result
 227
 228 0               Call succeeded / no Error
 229 != 0    NETWORKSTATUS structure describing the Error
 230
 231
 232 --------------------------------------------------------------
 233
 234
 235 NETWORKSTATUS *SendCCFCommand (SOCKET serv,char ccfstr[],byte repeat,word mask,byte LEDSel,byte bus)
 236
 237
 238 Send an IR Code defined by a CCF/Philips Pronto Hex Code. Extended external LED selection.
 239
 240
 241 Supported
 242
 243 irserver                >= 5.1.1
 244 LAN DB modules  all versions
 245
 246
 247 Parameters
 248
 249 SOCKET serv
 250
 251 Connection handle for the irserver connection
 252
 253 char ccfstr[]
 254
 255 Text string with the CCF Hex Code (Format like: "0000 007D 0013 0044 ....".
 256 Max. Length of the String: 256 Hex words
 257
 258
 259 int mask
 260
 261 Address mask for the IRTrans serial Bus. Contains a 16 Bit bit mask for up to 16 devices.
 262 0xffff -> Send to all devices on the Bus
 263
 264 byte LEDSel
 265
 266 Select the LEDs used to send.
 267
 268 Values:
 269
 270 0 or d          Default (as set in devices EEPROM)
 271 i                       Internal LEDs
 272 e                       External LEDs
 273 b or a          All LEDs
 274 1 to 8          External LEDs of LAN Controller / LAN Controller XL
 275
 276 int bus
 277
 278 Select the LAN / USB / RS232 device connected to the server. 0 = first device, 1 = 2nd and so on.
 279 255 selects all busses / devices.
 280
 281 Result
 282
 283 0               Call succeeded / no Error
 284 != 0    NETWORKSTATUS structure describing the Error
 285
 286
 287 --------------------------------------------------------------
 288
 289
 290 NETWORKSTATUS *SendCCFCommandLong (SOCKET serv,char ccfstr[],byte repeat,word mask,byte LEDSel,byte bus)
 291
 292
 293 Send an IR Code defined by a CCF/Philips Pronto Hex Code. Support for long CCF Codes.
 294 Extended external LED selection.
 295
 296
 297 Supported
 298
 299 irserver                >= 5.8.5
 300 LAN DB modules  Ethernet version >= 1.05.10
 301
 302
 303 Parameters
 304
 305 SOCKET serv
 306
 307 Connection handle for the irserver connection
 308
 309 char ccfstr[]
 310
 311 Text string with the CCF Hex Code (Format like: "0000 007D 0013 0044 ....".
 312 Max. Length of the String: 450 Hex words
 313
 314
 315 int mask
 316
 317 Address mask for the IRTrans serial Bus. Contains a 16 Bit bit mask for up to 16 devices.
 318 0xffff -> Send to all devices on the Bus
 319
 320 byte LEDSel
 321
 322 Select the LEDs used to send.
 323
 324 Values:
 325
 326 0 or d          Default (as set in devices EEPROM)
 327 i                       Internal LEDs
 328 e                       External LEDs
 329 b or a          All LEDs
 330 1 to 8          External LEDs of LAN Controller / LAN Controller XL
 331
 332 int bus
 333
 334 Select the LAN / USB / RS232 device connected to the server. 0 = first device, 1 = 2nd and so on.
 335 255 selects all busses / devices.
 336
 337 Result
 338
 339 0               Call succeeded / no Error
 340 != 0    NETWORKSTATUS structure describing the Error
 341
 342
 343 **************************************************************
 344
 345 Learning IR
 346
 347 **************************************************************
 348
 349
 350 NETWORKSTATUS *LearnIRCode (SOCKET serv, char rem[],char com[],unsigned short timeout)
 351
 352
 353 Learn an IR Code
 354
 355 Supported
 356
 357 irserver                all versions
 358 LAN DB modules  Learning of codes is only supported through the irserver
 359
 360
 361 Parameters
 362
 363 SOCKET serv
 364
 365 Connection handle for the irserver connection
 366
 367 char rem[]
 368
 369 Name of the remote control
 370
 371 char com[]
 372
 373 Name of the IR Command
 374
 375 unsigned short timeout
 376
 377 Time to wait for the IR Code
 378
 379 Result
 380
 381 0               Call succeeded / no Error
 382 != 0    NETWORKSTATUS structure describing the Error
 383
 384
 385 --------------------------------------------------------------
 386
 387
 388 NETWORKSTATUS *LearnRepeatIRCode (SOCKET serv, char rem[],char com[],unsigned short timeout)
 389
 390 Learn a repeat IR Code (Code that is sent when the button is held down)
 391
 392 Supported
 393
 394 irserver                all versions
 395 LAN DB modules  Learning of codes is only supported through the irserver
 396
 397
 398 Parameters
 399
 400 SOCKET serv
 401
 402 Connection handle for the irserver connection
 403
 404 char rem[]
 405
 406 Name of the remote control
 407
 408 char com[]
 409
 410 Name of the IR Command
 411
 412 unsigned short timeout
 413
 414 Time to wait for the IR Code
 415
 416 Result
 417
 418 0               Call succeeded / no Error
 419 != 0    NETWORKSTATUS structure describing the Error
 420